home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / nt / emacssrc.zip / EMACSSRC.TAR / emacs-19.17 / readme < prev    next >
Text File  |  1993-07-18  |  4KB  |  79 lines
  1. This directory tree holds version 19.17 of GNU Emacs, the extensible,
  2. customizable, self-documenting real-time display editor.
  3.  
  4. Please note that version 19 of Emacs is still in beta-test.  Although
  5. you may well encounter bugs in this release, we encourage you to use
  6. it, find the bugs, and report them; your bug reports are valuable
  7. contributions to the FSF, since they allow us to notice and fix
  8. problems on machines we don't have, or in code we don't use often.
  9. See the "Bugs" node of the info tree for more information on how to
  10. report bugs.
  11.  
  12. See the files `etc/NEWS' and `etc/news.texi' for information on new
  13. features and other user-visible changes since the last version of
  14. Emacs.
  15.  
  16. The file INSTALL in this directory says how to bring up GNU Emacs on
  17. Unix, once you have loaded the entire subtree of this directory.
  18.  
  19. Note that the Emacs installation procedure has changed since version
  20. 18; you will probably want to read the file INSTALL even if you have
  21. installed Emacs before.  The new procedure is intended to simplify
  22. Emacs installation, and make it easier to have several versions of
  23. Emacs for several architectures installed simultaneously.
  24.  
  25. The file PROBLEMS contains information on many common problems that
  26. occur in building, installing and running Emacs.
  27.  
  28. Reports of bugs in Emacs should be sent to the mailing list
  29. bug-gnu-emacs@prep.ai.mit.edu.  See the "Bugs" node of the info tree
  30. for more information on how to report bugs.  See `etc/MAILINGLISTS'
  31. for more information on mailing lists relating to GNU products.
  32.  
  33. The `etc' subdirectory contains several other files, named in
  34. capital letters, which you should look at when installing GNU Emacs.
  35.  
  36. The file `configure' is a shell script to acclimate Emacs to the
  37. oddities of your processor and operating system.  It will create two
  38. files named `build-install' (a shell script) and `Makefile' (a script
  39. for the `make' program), which help automate the process of building
  40. and installing emacs.  See INSTALL for more detailed information.
  41.  
  42. The file `configure.in' is the input used by the autoconf program to
  43. construct the `configure' script.  Since Emacs has configuration
  44. requirements that autoconf can't meet, `configure.in' uses an unholy
  45. marriage of custom-baked configuration code and autoconf macros; it
  46. may be wise to avoid rebuilding `configure' from `configure.in' when
  47. possible.
  48.  
  49. The files `Makefile.in' and `build-install.in' are templates used by
  50. `configure' to create `Makefile' and `build-install'.
  51.  
  52. The file `make-dist' is a shell script to build a distribution tar
  53. file from the current Emacs tree, containing only those files
  54. appropriate for distribution.  If you make extensive changes to Emacs,
  55. this script will help you distribute your version to others.
  56.  
  57. There are several subdirectories:
  58.  
  59. `src' holds the C code for Emacs (the Emacs Lisp interpreter and its
  60.     primitives, the redisplay code, and some basic editing functions).
  61. `lisp' holds the Emacs Lisp code for Emacs (most everything else).
  62. `lib-src' holds the source code for some utility programs for use by
  63.     or with Emacs, like movemail and etags.
  64. `etc' holds miscellaneous architecture-independent data files
  65.     Emacs uses, like the tutorial text and the Zippy the Pinhead quote
  66.     database.  The contents of the `lisp', `info' and `man'
  67.     subdirectories are architecture-independent too.
  68.  
  69. `info' holds the Info documentation tree for Emacs.
  70. `man' holds the source code for the Emacs manual.
  71.  
  72. `cpp' holds a C preprocessor for use instead of the installed one when
  73.     the installed one fails to distinguish more than 8 characters in a
  74.     symbol name.
  75. `shortnames' holds programs and data files for creating files of
  76.     #define's used to convert long symbol names to distinct sort ones
  77.     for C compiles that cannot distinguish more than 8 characters.
  78. `vms' holds instructions and useful files for running Emacs under VMS.
  79.